MarkLogic 9 Product Documentation
GET /manage/v2/databases/{id|name}/alert/actions/{id|name}Summary
Return the configuration for the specified alert action.
| URL Parameters |
| uri |
The URI of the alert for which to return the action.
This parameter is required. |
| format |
The format of the data in the response body.
Allowed values: html, json or xml (default). Use this
parameter to override the Accept header. |
| Request Headers |
| Accept |
The desired MIME type of the data in the response
body. If the format parameter is present, it takes precedence over this header.
Supported values: application/xml (default), application/json,
text/html. |
| Content-type |
The MIME type of the data in the request
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html. |
| Response Headers |
| Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
|
Response
Upon success, MarkLogic server returns status code 200 (OK) and the response
body contains the requested data. A status code of 401 (Unauthorized) is returned if the user
does not have the necessary privileges.
Required Privileges
This operation requires the
manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
For details,
see
Actions to Execute When an Alert Fires in the
Search Developer's Guide.
The structure of the output returned from
this REST API is as follows:
namemetaProperties of the view rather than the resource.
This is a complex structure with the following children:
uriThe path to the view.
current-timeThe timestamp for when the view was generated.
elapsed-timeThe time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-minThe timestamp for filtering out more recent
requests or transactions.
view-errorAn error limiting the data in the view.
This is a complex structure with the following children:
error-typeThe kind of error.
error-nameThe name of the error.
error-codeThe error identifier.
error-messageThe error text.
relationsRelationships to resources.
This is a complex structure with the following children:
relation-groupRelated resources with the same type.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
relation-countThe number of related resources.
relationA specific related resource.
This is a complex structure with the following children:
qualifiersA list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifierAnother resource that qualifies the resource.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
related-viewsA list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-viewA broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-typeThe kind of view.
view-nameThe name of the view.
view-uriThe path for the view.
Example
http://localhost:8002/manage/v2/databases/Documents/alert/actions/xdmp:log2?uri=my-alert-config
==> Retrieve the configuration of the alert action with the id, "xdmp:log2."
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.